Skip to main content

Generic Connector

The Generic System Connector allows publishing information and enriching other work systems from any external system by calling SyncNow's DevOps Gate.

This connector is ideal for integrating with systems such as Jenkins or SAST/DAST tools, enabling these systems to enhance target work systems like JIRA with relevant information.

✨ Key Features

  • Information Publishing: Publish data from various systems to enrich other connected work systems.
  • Flexible Integration: Compatible with multiple systems, including Jenkins and SAST/DAST tools.
  • DevOps Gate Integration: Specifically designed for use with DevOps Gate processes.

⚙️ How the Generic Connector Works with DevOps Gate

The Generic Connector leverages SyncNow's DevOps Gate API to allow any external system to create, update, comment on, or link entities in any connected work system. This is achieved by sending HTTP requests to the DevOps Gate endpoints with the required data.

Supported Actions

  • Add Comment: Add comments to entities in any connected system.
  • Create Entity: Create new entities in the target system.
  • Update Entity: Update existing entities with new information.
  • Add Link: Add links or remote references to entities.

📝 Example: Add a Comment to Entities

You can use the Generic Connector to add a comment to any work system entity. The comment can contain information such as build or release URLs, security or quality test results, and more.

Usage Examples

  1. Add build URL and comment to work system entities.
  2. Add Security or Quality Test URL to work system entities.

API Request

POST /api/v1.0/DevOpsGate/Enrich/{DevOpsGateProcessID}?action=comment

Request Body Example

[
  {
    "eventRelativeURL": "/relative/url/path",
    "comments": "String with entities unique identifiers from the target system to add comments or remote link. For example, this is a comment in some commit. Need to update entities #sys1-12345, #sys2-SYN-123",
    "commentLinkOrRelationTitle": "Build was triggered in Jenkins"
  }
]

Parameters

ParameterDescription
eventRelativeURLA relative URL from the source system to add as a link in the comment.
commentLinkOrRelationTitle(Optional) The title for the link in the comment.
commentsString with unique entity identifiers (e.g., #sys1-12345) to update in the target system.

API Response Example

{
    "updatedEntitiesID": [
        {
            "systemID": "10",
            "entityKeys": [
                "CLS-3938",
                "CLS-3933"
            ]
        }
    ],
    "errors": [],
    "warnings": []
}
ParameterDescription
updatedEntitiesIDList of updated entity IDs
systemIDThe target system ID where entities updated
entityKeysThe updated entities keys
errorsErrors that occurred during the update
warningsWarnings that occurred during the update

🚀 Other Supported DevOps Gate Actions

You can use the Generic Connector with DevOps Gate to perform additional actions:

  • Create Entity 
    POST /api/v1.0/DevOpsGate/Enrich/{DevOpsGateProcessID}?action=create
  • Update Entity 
    POST /api/v1.0/DevOpsGate/Enrich/{DevOpsGateProcessID}?action=update
  • Add Link to Entity 
    POST /api/v1.0/DevOpsGate/LinkIt/{DevOpsGateProcessID}

Each action requires a properly structured request body, typically including entity identifiers and the data to be created, updated, or linked.

🛠️ Step-by-Step Example: Add a Comment to Entities

  1. Create a DevOps Gate Process
    Set up a DevOps Gate process in SyncNow for your integration scenario.

  2. Create Entities in the Target System
    Ensure the entities you want to update exist in the target system.

  3. Get the DevOps Gate Process Configuration
    Navigate to the DevOps Gate Process Configuration and press the "How It Works" link.

  4. Select the Desired Action
    Choose "add comment", "create", "update", or "add link" as needed.

  5. Copy the CURL Command
    Use the provided CURL command as a template.

  6. Execute the Request
    Paste the command into your terminal, set the entity keys, and execute.

  7. Verify the Result
    The comment, entity, or link will be added or updated in the target system.

⚡ Compatibility and Limitations

  • Compatibility: The Generic System Connector can be used with various external systems, including but not limited to Jenkins, SAST, and DAST tools.
  • Limitations:
    • This connector is currently only utilized for DevOps Gate processes.

By following these steps, you can set up and use the Generic System Connector to enhance your workflows and integrate various systems seamlessly with SyncNow.